1995 document no. eeu-1536 (o. d. no. eeu-5006) date published may 1995 p printed in japan user's manual doc17k document processor (preliminary)
RA17K ) or c compiler ( emlc-17k tm ) source programs and documents the information in a specified format. audience: this manual is aimed at those engineers who use RA17K or emlc-17k to develop application systems based on the 17k series 4-bit single-chip microcontroller. organization: this manual consists of the following chapters: general running the document processor types of output listings and options output listings error messages reading this manual: the reader is assumed to be familiar with the concepts of RA17K or emlc-17k . conventions: in this manual, the following symbols are used: ... : indicates repetition. [ ] : elements in brackets are optional. {|} : one of the characters or character strings, delimited by | in braces, must be selected. < > : the actual characters enclosed in the angular brackets are to be specified; often used to indicate a title. cr : carriage return. lf : line feed. tab : horizontal tab.
RA17K users manual : to be released soon RA17K utility users manual : to be released soon lk17k users manual : to be released soon emlc-17k version 1.00 users manual : eeu-1427 doc17k users manual : this manual ? documents related to simplehost tm simplehost version 2.0 corresponding to emlc-17k /RA17K users manual, tutorial: to be released soon simplehost version 2.0 corresponding to emlc-17k /RA17K users manual, reference: to be released soon the software package may contain a readme.doc file. the readme.doc file provides information that was not available when the manual was printed. always read the contents of the readme.doc file before attempting to use the product.
RA17K ) or c compiler (emlc-17k) source programs and documents the information in a specified format. 1.1 configuration the multi-functional document processor consists of several sets of utilities and programs that manage these utilities. figure 1-1. doc17k functions (note) available only when emlc-17k is used. memory map generation functions map17k amap17k mod17k doc17k document processor document generation functions cross-reference generation functions xref17k pub17k report writing function rep17k: report listing utility : module map listing utility : program map listing utility : address map output (produced with the module listing utility) spec17k mod17k tree17k (note) : document listing utility : module listing utility : call tree listing utility : cross-reference listing utility : public cross-reference listing utility doc17k user's manual 1 - 1
RA17K (relocatable assembler) emlc-17k (c compiler) rel file (.rel) intermediate prn file (.ipn) xref data file (.ixf) summary file (.sum) log file (.log) preprocessing file (.ppl) xref data file (.ixf) summary file (.sum) log file (.log) lk17 (linker) lnk file (.lnk) doc17k (document processor) absolute address format listing (.prn) C> output with list17k cross-reference listing (.xrf) C> output with xref17k public cross-reference listing (.pub) C > output with pub17k report listing (.rep) C> output with rep17k module map listing (.map) C> output with map17k program map list (.amp) C> output with amap17k document listing (.spc) C> output with spec17k module listing (.mod) C> output with mod17k call tree listing (.tre) C> output with tree17k available only when emlc-17k is used.
RA17K or emlc-17k . a lnk file (.lnk) must be specified at the same time, by specifying the -lnk option. (b) log file (.log) a file recording the messages output by RA17K or emlc-17k upon assembly or compilation. (c) intermediate prn file (.ipn) an assembly result list file produced by RA17K . (d) preprocessing file (.ppl) a precompilation result list file produced by emlc-17k . (e) cross-reference data file (.ixf) an information file used to produce a symbol cross-reference listing. (f) summary file (.sum) a file of information defined by a summary pseudo instruction. (2) files that are created (a) absolute address format listing (.prn) an edited listing, represented in absolute address format, of the contents of an intermediate prn file, along with the address and object codes stored in it. (b) cross-reference listing (.xrf) an edited listing of cross-reference information. (c) public cross-reference listing (.pub) an edited listing of cross-references between the public symbols of a program. (d) module map listing (.map) a module-specific data memory map, presented as a table. (e) program map listing (.amp) a program data memory map, presented as a table.
RA17K or emlc-17k , presented as a listing. (g) document listing (.spc) summary information, and information derived from an intermediate prn file, presented as a document. (h) call tree listing (.tre) a tree listing of all the functions defined and referenced by emlc-17k . (i) module listing (.mod) a module file-specific routine listing, which may contain a program address map if needed. 1.4 operating environment doc17k requires the operating environment described below: ? host machine : nec pc-9800 series ibm pc/at tm ? os : ms-dos tm ver.3.30 or higher pc dos tm ver.5.02 or higher ? main memory : 640k bytes or more. at least 400k bytes of free memory is required. ? extended memory (ems) : at least 1m byte of extended memory is recommended. ? external storage : at least 1m byte. (the use of a hard disk is recommended.) 1.5 environmental variable the following environmental variable is used with doc17k: tmp: specifies a temporary file search path. if more than one path is specified, only that specified first becomes valid. paths are used in the following order: <1> if a work path option (-work) is specified, temporary files are created on that path. <2> if environmental variable tmp is specified, temporary files are created on that path. <3> if neither <1> nor <2> is specified, temporary files are created on the current path.
-lnk=[-...] ? running listing utilities independently >xxx17k[.exe]-lnk=[-...] table 2-1 lists the listing utilities and indicates the order in which they are excuted by doc17k. table 2-1. listing utilities name description execution order list17k absolute address format listing utility 1 xref17k cross-reference listing utility 2 pub17k public cross-reference listing utility 3 map17k module map listing utility 4 amap17k program map listing utility 5 rep17k report listing utility 6 spec17k document listing utility 7 mod17k module listing utility 8 tree17k call tree listing utility 9 doc17k user's manual 2 - 1
RA17K , emlc-17k , and lk17k. for more details on the file output options, refer to the RA17K , emlc-17k , and lk17k users manuals. table 3-3. input files required to enable listing output input file intermediate rel file lnk file xref file summary log file output listing (option) prn file file absolute address format listing o o o o (note 1) (-lis[t]) cross-reference listing (-xre[f]) o o o public cross-reference listing (-pub[xref]) module map listing (-map) o (note 2) o o program map listing (-ama[p]) report listing (-rep[ort]) o o o document listing (-spe[c]) o o o o o module listing (-mod[ule]) o o call tree listing (-tre[e]) o (note 3) o (note 1) used when -bra[nch] is specified. (note 2) used to extract symbol definition comments. (note 3) with emlc-17k , use a preprocessing file instead of an intermediate prn file.
RA17K v1.00 v1 << ******* *** list>>... prog = ***** (6) -wor[k]=pathname specifies the work drive and directory used by the document processor. if environmental variable tmp is specified, the tmp path is used when this option is omitted. if environmental variable tmp is not specified, the current path is used. 3.1.3 listing-specific options listing-specific options can be specified. all options for each listing utility can be specified when doc17k starts. once a listing utility has been run independently, however, only those options specific to that listing can be specified. remember that an option error is likely to result if the parameter file used to start doc17k is used as the parameter file for running a particular listing utility. (1) absolute address format listing options table 3-9. absolute address format listing options option name default explanation -gen gen macro and repeat pseudo instruction expansion -nog[en] control -con[d] con conditional statement control -noc[ond] -seq nos option information listing control -nos[eq] -bra[nch] nob embedded cross-reference listing control -nob[ranch]
RA17K users manual for details of the macro expansion control pseudo instructions. (b) -con[d]/-noc[ond] controls the listing of an if, ifchar, ifnchar, ifstr, or case conditional statement when the is false. the default is -con[d]. table 3-11. -cond option settings setting explanation -con[d] lists all statements regardless of the condition. -noc[ond] controls the listing of the conditional statement with sfcond/ lfcond pseudo instructions in the source program. remark refer to RA17K users manual for more details on the conditional listing output control pseudo instructions. (c) -seq/-nos[eq] controls the listing of option information. the default is -nos[eq]. table 3-12. -seq option settings setting explanation -seq produces an option information listing. -nos[eq] does not produce an option information listing.
RA17K \sample.asm(5) : 00000001 : local : mem : symbol-name b:\RA17K \sample.asm(8) (4) report listing option table 3-22. report listing option option name default explanation -rfm[t]=filename C names a report listing format file. (a) -rfm[t]=filename names the format file containing the user-specified format in which a report listing is to be produced. if this option is omitted, the output format shown in figure 3-1 is assumed.
RA17K ), compiler (emlc-17k) , linker (lk17k), and document processor (doc17k), can be output as a listing. (1 ) option specify -seq to produce an option information listing. when -nol[ist] is specified, however, specifying -seq does not allow option information listing. an option information listing is output at the beginning of each module-specific absolute address format listing. (2 ) output file absolute address format listing (.prn) (3 ) output details an option listing is output. (a ) module option the assembly (or compilation) options specified at the initiation of RA17K (or emlc-17 k ) and the options specified at the initiation of doc17k are listed. the options are listed along with their specified values, or with the defaults when no values are specified. (b ) link option the linker options specified at the initiation of lk17k are listed. the options are listed along with their specified values, or with the defaults when no values are specified. doc17k user's manual 4 - 1
RA17K v1.00 v1 << d17xxx assemble list >> hh:mm:ss mm/dd/yy page 001 prog = sample noobj/obj : obj=a:\RA17K \sample. rel nound/und : nound include : include= nolist/list : list=a:\RA17K \sample. ipn noxref/xref : xref=a:\RA17K \sample. ixf zzz0 : zzz0=0 zzz1 : zzz1=0 zzz2 : zzz2=0 zzz3 : zzz3=0 zzz4 : zzz4=0 zzz5 : zzz5=0 zzz6 : zzz6=0 zzz7 : zzz7=0 zzz8 : zzz8=0 zzz9 : zzz9=0 zzz10 : zzz10=0 zzz11 : zzz11=0 zzz12 : zzz12=0 zzz13 : zzz13=0 zzz14 : zzz14=0 zzz15 : zzz15=0 warning : warning=4 absolute/relocatable : relocatable summary/nosummary : nosummary host/nohost : nohost work : work=d:\ tagstart : tagstart=. tagend : tagend=.. nolist/list : list=sample. prn seq/noseq : seq branch/nobranch : nobranch gen/nogen : gen cond/nocond : cond notab/tab : notab=8 form/noform : noform row : row=66 column : column=80 work : work=d:\ lnk : lnk=sample.lnk head/nohead : head
RA17K \sample. lnk noice/ice : ice=a:\RA17K \sample.ice noprom/prom : noprom host/nohost : nohost work : work=d:\ warning : warning=0 increment/noincrement : noincrement directive : directive= parameter : parameter= prog : prog= indirect : indirect= junk/nojunk : nojunk nol/lmap : lmap=a:\RA17K \sample.lmp RA17K v1.00 v1 << d17xxx assemble list >> hh:mm:ss mm/dd/yy page 002 prog = ml/noml : noml mp/nomp : nomp 4.2 absolute address format listing the results of source program assembly and linkage are converted to absolute addresses for assembly listing. (1) option specify -list to produce an absolute address format listing. (2) output file absolute address format listing (.prn) (3) output details (a) line format eeee stno loc.object m i source statement
RA17K users manual for details of the line format. (b) listing of statements expanded in the macro, repeat, and include parts statements expanded in the macro, repeat, and include parts are listed according to the following: ? stno : a + sign and the line number of each expanded statement are listed until the expansion ends. the expanded statement line number is incremented each time expansion is performed. ? m : the nesting levels of macros, repeat instructions, and built-in macros are listed. ? i : the nesting level of include pseudo instructions is listed. (c) error statement listing if error statements have been encountered, error codes and error numbers are listed in place of eeee. refer to the RA17K or emlc-17k users manual for details of the error codes and error numbers. (d) end of listing the end of a listing is identified by the output of the following information: ? total errors : total number of errors that occurred during source module assembly. ? total warnings : total number of warnings generated during source module assembly. (e) related pseudo instructions ? title : whenever a title pseudo instruction is encountered, a form feed is performed and a title is output as a header on the new page. title output continues until the next title pseudo instruction is encoun- tered.
RA17K users manual for details of the listing control instructions.
RA17K v1.00 v1 << d17xxx assemble list >> hh:mm:ss mm/dd/yy page 001 prog = sample source = sample. asm eeee stno loc. object m i source statement 225 ; ********************************************** 226 ; * 227 ; * reset power on reset process 228 ; * 229 ; ********************************************** 230 00000d ireset: 231 00000d 071f0 di interrupt disable 232 233 ; ********************************************** 234 ; * port initialize 235 ; ********************************************** 236 237 00000e 1d790 mov bank, #0 238 00000f 1d700 mov rp0a, #cp0aini ; port0a 239 000010 1d710 mov rp0b, #cp0bini ; port0b 240 000011 1d720 mov rp0c, #cp0cini ; port0c key stb 241 000012 1d730 mov rp0d, #cp0dini ; port0d key in 242 243 000013 1d791 mov bank, #1 244 000014 1d700 mov rp1a, #cp1aini ; port1a 245 000015 1d710 mov rp1b, #cp1bini ; port1b 246 000016 1d720 mov rp1c, #cp1cini ; port1c 247 000017 1d730 mov rp1d, #cp1dini ; port1d 248 249 000018 1d792 mov bank, #2 250 000019 1d700 mov rp2a, #cp1aini ; port2a 251 00001a 1d710 mov rp2b, #cp1bini ; port2b 252 00001b 1d720 mov rp2c, #cp1cini ; port2c 253 using the epa area 254 10001c 1d790 mov bank, #0 255 10001d 1d7e0 mov rpl, #brbank0 256 257 ; ********************************************** 258 ; * register file set 259 ; ********************************************** 260 1 initflg p2abio3, p2abio2, p2abio1, p2abio0 + 1 2 set4 p2abio3, p2abio2, p2abio1, p2abio0 + 2 10001e 1d78f 2 mov wr, #1111b + 3 10001f 07324 2 poke .mf.p2abio3 shr 4. wr using the jump table ; jump table:?init 00000 0c000 total errors = 0 total warnings = 0 end of list
RA17K v1.00 v1 << d17xxx assemble list >> hh:mm:ss mm/dd/yy page 001 prog = sample source = sample. asm eeee stno loc. object m i source statement 5 public ireset : 123 ; ********************************************** 124 ; * reset power on reset process 125 ; ********************************************** p-23f, p-242, b-124, c-128 126 00000d ireset: 127 00000d 071f0 di : interrupt disable 128 129 ; ********************************************** 130 ; * port initialize 131 ; ********************************************** 132 133 00000e 1d790 mov bank, #0 134 00000f 1d700 mov rp0a, #cp0aini ; port0a 135 000010 1d710 mov rp0b, #cp0bini ; port0b 136 000011 1d720 mov rp0c, #cp0cini ; port0c key stb 137 000012 1d730 mov rp0d, #cp0dini ; port0d key in 138 : reference within the same module : 234 000124 0c00d br ireset ; br reset : 238 000128 1c00d call ireset ; call reset reference from another module 4 extrn lab:irset : 84 00023f 0c00d br ireset ; br reset : 98 000242 1c00d call ireset ; call reset
RA17K users manual for details. attribute (attr) public a symbol that can be referenced from other modules local a symbol that can be referenced only within the module in which it appears. type (type) dat data type mem memory type nn horizontal nibble memory type nnv vertical nibble memory type lab label type flg flag type mac macro str structure uni union ary array remark up to about 8,000 symbols can be contained within a cross-reference listing. [sample output] -xfo[rm]=0 RA17K v1.00 v1 << d17xxx xref list >> hh:mm:ss mm/dd/yy page 01-001 prog = sample source = sample. asm symbol value attr type /ref(#def) symbol name 00000001 local dat /#1, 2
RA17K v1.00 v1 << d17xxx xref list >> hh:mm:ss mm/dd/yy page 01-001 prog = sample source = sample. asm module(lineno.) : value : attr : type : symbol b:\RA17K \sample. asm(5) : 00000001 : local : mem : symbol-name b:\RA17K \sample. asm(8) b:\RA17K \sample. asm(12) b:\RA17K \sample1.mlc(7) : 00000000 : local : str : structured-symbol-name b:\RA17K \sample1.mlc(18) b:\RA17K \sample1.mlc(22) (2) public cross-references the definitions and reference positions of those symbols referenced from external modules are listed. (a) option specify -pub[xref] to list public cross-references. (b) output file public cross-reference listing (.pub) (c) output details (i) -xfo[rm]=0 symbol-name evaluation-value attribute type [m] reference/definition-line- number (#definition-line-number) (ii) -xfo[rm]=1 definition line: source-module-name(nn):evaluation-value:attribute: type:symbol-name reference line: source-module-name(nn)
RA17K users manual for details. attribute (attr) public symbol that can be referenced from other modules local symbol that can be referenced only within the module in which it appears. type (type) dat data type mem memory type nn horizontal nibble memory type nnv vertical nibble memory type lab label type flg flag type mac macro str structure uni union ary array remark up to about 8,000 symbols can be contained within a cross-reference listing. [sample output] -xfo[rm]=0 RA17K v1.00 v1 << d17xxx pubxref list >> hh:mm:ss mm/dd/yy page 01-001 prog = sample source = sample.asm symbol value attr type /ref(#def) symbol name 00000001 local dat /[1]# 1
RA17K v1.00 v1 << d17xxx pubxref list >> hh:mm:ss mm/dd/yy page 001 prog = sample module(lineno.) : value : type : symbol b:\RA17K \main. asm(5) : 00000001 : mem : public-symbol-name b:\RA17K \sample. asm(24) b:\RA17K \sub. asm(32) b:\RA17K \sample1. mlc(7) : 00000000 : str : structured-symbol-name b:\RA17K \sample2. mlc(18) b:\RA17K \sample3. mlc(22) 4.4 module map and program map listings 4.4.1 map listings a map listing presents memory definitions as a table. (1) options specify -map to output a module map listing or -ama[p] to output a program map listing. (2) output file ? module map listing (.map) -map : rel filename.map -map= : .map if more than one module is named, a map listing is output for each of the named modules. ? program map listing (.amp) -ama[p] : parameter filename.amp -ama[p]= : .amp a map listing in which the symbols of multiple modules are merged is output. (3) output details a map listing consists of a bank-specific listing of memory attribute (mem, nibblen, and nibblenv) symbols and flat attribute symbols. a map of the members of emlc-17k structures and unions is included. caution to output a structure and union map, specify a debug option at emlc-17k compile time. no structure or union map is output if this debug option is omitted.
RA17K v1.00 v1 << d17xxx data memory map >> hh:mm:ss mm/dd/yy page 01-001 prog = sample source = sample.asm 01234567 r o w 0 1 2 3 4 5 6 7 ^grl_1_d lcdd0 >grl_1_d >grl_1_d data top key_cou * rg0 lcdd1 >grl_2_d >grl_2_d vol_dat rg1 &struct ^grl_2_d &struct &struct &struct &abc[0] &abc[0] &abc[1] &abc[1] delay_w * rg2 lcdd2 >grl_3_d >grl_3_d ^grl_3_d lcdd3 k_dat delay_fl bal_dat dly_cou * rg3 ^pnv_sym ^pnv_sym lcdd4 ar3 dly_ixl ^k_dat_x >pn_sym >pn_sym ^pnv_sym level_d * lcd_da_3 ^k_dat_y lcdd5 ^grr_1_ * ^grl_7_d fad_dat ar2 ^k_dat_x dtm_ixm2 ^grl_5_d ^k_dat_x lcdd6 ^grr_1_ * ^grl_7_d ar1 ^k_dat_y ^grl_6_d ^grl_6_d ^grl_5_d lcdd7 ^grr_1_ * ^grl_7_d ar0 delay_fr sur_m_d * p_sym bank = 0 col
RA17K v1.00 v1 << d17xxx flag map >> hh:mm:ss mm/dd/yy page 01-001 prog = sample source = sample.asm bank = 0 msb 3 2 1 0 lsb 63 66 68 70 lcd_dwn lcd_up p_flg1 p_flg2 p2a3 p2a2 p2a1 p2a0 [sample output 3] a sample listing of the structure definition shown below is presented on the following pages. struct puba { byte a1; byte a2[2]; struct pubb { byte b1; byte b2[2]; } pubb1; struct pubb pb2[2]; };
RA17K v1.00 v1 << d17xxx structure map >> hh:mm:ss mm/dd/yy page 01-001 prog = sample source = sample. mlc ^b2[0] 0 01 2 3 4 5 6 7 col r o w ^b1 ^b1 ^b2[0] ^b2[1] ^b2[1] struct = pubb RA17K v1.00 v1 <> hh:mm:ss mm/dd/yy page 01-001 prog = sample source = sample.mlc 1 2 ^a1 ^a2[0] ^a1 01 23 45 67 ^a2[0] ^a2[1] ^a2[1] &pubb1 &pubb1 &pubb1 &pubb1 &pubb1 &pubb1 &pb2[0] &pb2[0] &pb2[0] &pb2[0] &pb2[0] &pb2[1] &pb2[0] &pb2[1] &pb2[1] &pb2[1] &pb2[1] &pb2[1] 0 r o w col struct = puba 4.4.2 symbol listing the map listings are followed by a symbol listing that consists of memory and flag symbol information. (1) option specify -map to produce a module-specific symbol listing, or -ama[p] to produce a symbol listing for an entire program.
: .map if more than one module is named, a map listing is produced for each of the named modules. ? program map listing (.amp) -ama[p] : parameter filename.amp -ama[p]= : .amp a map listing consisting of symbols from multiple modules is produced. (3) output details symbol value type bit information the table below details the line format. legend output value explanation symbol symbol name symbol name. when a symbol name exceeds the value of - symlength, (one double-byte character or two single-byte characters), only the symbol name is output on the first line. all the information following value is directed to the subsequent lines. evaluation value 32 bits (hexadecimal) refer to the RA17K users manual for details. (value) type (type) dat data type mem memory type nn horizontal nibble memory type nnv vertical nibble memory type lab label type flg flag type bit bit position 1 1 2 ..1. 4 .1.. 8 1 str structure uni union ary array information C contents of the comment on the symbol definition line
RA17K v1.00 v1 << d17xxx symbol map >> hh:mm:ss mm/dd/yy page 01-001 prog = sample source = sample. asm symbol value type bit information abc_mem 00000010 mem ; public variable work 00000021 flg 1 ; local variable abc_nib 00001003 n2 ; nibble 2 xyz_nibv 00009004 n2v ; nibble 2 v struct 00000000 str ; structure union 00000000 uni ; union array 00000000 ary ; array 4.5 report listing a report listing provides a record of the status of assembly execution, including the assembly time spent, the status of memory utilization, and file information. (1) option specify -rep[ort] to output a report listing. (2) output file report listing (.rep) (3) output details (a) run durations the time at which assembly started, the time at which it ended, and the elapsed time. if more than one module is named, run durations are listed in sequence. (b) status of memory utilization the memory utilization status for the assembler. if more than one module is named, the memory utilization status is output for each of the named modules. (c) file information the sizes of the files used by the assembler. if more than one module is named, file information is output for each of the named modules.
RA17K v1.00 v1 << d17xxx report list >> hh:mm:ss mm/dd/yy page 001 prog = sample process assembler(test1. asm) assembler(test2. asm) compiler(sample3. mlc) compiler(sample4. mlc) start 13:02:05 13:04:00 13:05:20 13:06:04 13:03:17 13:05:17 13:06:03 13:06:17 end elapsed 00:01:12 00:01:17 00:00:43 00:00:13 total 00:03:25
RA17K v1.00 v1 << d17xxx report list >> 10:34:40 04/22/93 page 002 prog = sample source = test1. asm < used memory > memory blocks rel rel rel rel interm xref symbol symbol list etc tmp tmp tmp file tmp file main ems tmp size 4317 2269 4317 4341 8413 8437 16384 0 4341 5223 used 259 669 515 1145 242 245 16384 0 393 520 percent 6.0 29.1 11.9 26.4 2.9 2.9 100.0 0.0 9.1 10.0 < used files > file names c:\RA17K \system\rep17k\test1. rel c:\RA17K \system\rep17k\test1. ixf c:\RA17K \system\rep17k\test1. ipn size 900 0 148 (4) coding a format definition file a format definition file can be specified with the -rfmt option to output a report listing in a user-specified format. a format definition file is coded by preceding each line with a line control character. normal lines are marked by n, the last line by p. the last line is mandatory. item coding formats are described below. (a) %d#item-name [,number-of-characters]% item-name may be either a reserved item name or a user-defined item name. if number-of-characters is omitted, the item is output using the number of characters of item-name.
the #toc character string specified in the format definition file is output. chapter 1 module title 1 1.1 section title 2 1.1.1 routine title 3 (1) tag title 1 3 (2) tag title 2 3 (3) tag title 3 3
RA17K and emlc-17k . a document listing, output as explained in [sample coding of a format definition file] in section 4.6.3(3) , is given on the following pages.
RA17K v1.00 v1 << d17xxx document list >> hh:mm:ss mm/dd/yy page 001 prog = sample chapter 1. initial institution [specifications] module summary module name : initial. asm create : 92/07/01 13:12:11 size : 4096 step : 20 public (mem) : pub_mem public (flg) : pub_flg public (dat) : pub_dat public (lab) : pub_lab extrn (mem) : ext_mem extrn (flg) : ext_flg extrn (dat) : ext_dat extrn (lab) : ext_lab (iii) routine summary the information written in the routine block is edited and output according to the format definition. the output format is the same for both RA17K and emlc-17k . for RA17K , however, input/output information is not output.
RA17K v1.00 v1 <> hh:mm:ss mm/dd/yy page 002 prog = sample 2.1 volume control [specifications] routine summary [routine information] input : nibble a output : dword b address range : 0 - 1f epa address range : 10020 - 1002f jumpt address range : 0 - 0 entrances : init mem changed : m_chg mem referred : m_ref mem manipulatd : flg changed : f_chg flg referred : f_ref dat referred : branch to : subroutines called : d17005_init lab manipulated : system call : 2.1.1 mode_key delay change delay key delay institution 4.6.2 summary rules the summary rules described in each module (source file) are presented. a comment symbol is not needed between the summary and endsum statements. #pragma summary is presented in a comment format. summaries cannot be nested by themselves. summary statements appearing in tags are directed to the tag table of the program specifications.
summary 1 (module summary) summary 2 (routine summary) tags can be nested tags can be nested (1) program summary (a) title the information specified with -sum[mary]. (b) summary statement defined in the separate file for program summary statements, as named by -sum[mary]. see section 4.6.1(3)(b)(i) .
RA17K , or with //. for emlc-17k . this hierarchical level is terminated by ;.. or //... titles can be nested. the character strings (. and ..), following a comment symbol, can be altered by using RA17K options -tags[tart] and -tage[nd]. (b) summary statement any comment statement appearing after a tag line is handled as a summary statement. a summary statement is terminated by a non-comment line.
RA17K ] ; sample summary summary module name title provides a summary of the module (may be omitted). endsum summary routine title provides a summary of the routine (may be omitted). endsum prog1 cseg ;. tag title ; the comment following the tag is assumed to be a summary statement ; the summary statement is terminated by other than a comment statement ;. v ; the immediately subsequent label is registered as a tag ; a comment following a tag is regarded as being a summary statement ; the summary statement is terminated by other than a comment statement label1: summary <- the section name is assumed as the title when no title is explicitly specified. provides a summary of the routine (may be omitted). endsum prog2 cseg end
}
:: #row #column #toc #idn n: level number (note) #moduleform module specification format #routineform routine specification format (note) item number formats are as follows: 1 = chapter n (double-byte characters) 7 = (n) (single-byte characters) 2 = n (double-byte characters) 8 = (a) (double-byte letters) 3 = n (single-byte characters) 9 = (a) (single-byte letters) 4 = n. n ... (double-byte characters) 10 = <1> to <20> (double-byte characters> 5 = n.n ... (single-byte characters) 11 = . (double-byte characters) 6 = (n) (double-byte characters) 12 = . (single-byte characters) (2) item name the contents of the item specified by an item name in the format definition file are retrieved from the source module to replace each occurrence of the item name.
RA17K ] ; : ; : ; [item name sample coding: emlc-17k ] // : // : //
. caution a call tree listing is produced only for the emlc-17k source program. [sample output] mlc17k v1.00 v 1 << d17xxx tree list >> hh:mm:ss mm/dd/yy page 001 prog = sample main 1 initialize_table 1 clear_buffer 2 set_table 2 initialize_key 1 key_xxxx ? 2 key_yyyy 3 display 1 menu 1 function_one 1 set_func [3.1.1.1] 1 exec_key 2 function_two 1 set_func. . . [3.1.1.1] 3 function_three 1 set_func. . . [3.1.1.1] 2 modify_mode
RA17K , a section name is output for each routine name field. (1) option specify -mod[ule] to output a module listing. (2) output file module listing (.mod) (3) output details a sample listing is shown below. 4 function_four 1 set_func. . . [3.1.1.1] 2 change_case 1 attriv 1 convert_mode 5 function_end 1 set_func. . . [3.1.1.1] 2 perform 4 exit
RA17K v1.00 v1 << d17xxx module list >> hh:mm:ss mm/dd/yy page 02-001 prog = sample source = sample2. asm module name c:\include\keyfunc1.asm c:\include\keyfunc2. asm c:program\source\keyfunc. asm routine name initialize_key clear_key_buffer set_key_table created date/time 1991/12/16 10:03:00 1991/10/30 00:00:00 1991/11/01 00:00:00 src steps1 address range 133 98 202 00150 - 00153 00154 - 00179 0017 a - 0017 f 1932 324 549 file size 4.9 address map an address map file contains routines (functions) and variables assigned in rom. an address map is output page by page (page0 to page3). caution when source programs have been assembled using RA17K , a section name is output in each routine name field. (1) option specify -pma[p] to produce an address map. (2) output file module file (.mod) (3) output details a sample listing is shown below.
RA17K v1.00 v1 <> hh:mm:ss mm/dd/yy page 001 prog = sample segment no = x ?_initialize initialize @_initialize routine name/variable clear input output main. asm main. asm main. asm module name sub . asm sub2. asm sub3. asm 00000 - 00000 00100 - 00123 10124 - 1012f address 00800 - 0012f 01000 - 0130e 01800 - 0004f page0 page1 page2 page3
